<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: Academy Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1Academy.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="#events">Events</a> &#124;
<a href="classUnity_1_1MLAgents_1_1Academy-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Academy Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> singleton manages agent training and decision making.  
 <a href="classUnity_1_1MLAgents_1_1Academy.html#details">More...</a></p>

<p>Inherits IDisposable.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3e751afdd9bf94606b74c3ec143bef6e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a3e751afdd9bf94606b74c3ec143bef6e">EnvironmentStep</a> ()</td></tr>
<tr class="memdesc:a3e751afdd9bf94606b74c3ec143bef6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a single environment update of the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> and <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> objects within the environment.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a3e751afdd9bf94606b74c3ec143bef6e">More...</a><br /></td></tr>
<tr class="separator:a3e751afdd9bf94606b74c3ec143bef6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e2d745cdb7a7b983f861ed6a9a541a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a6e2d745cdb7a7b983f861ed6a9a541a7">Dispose</a> ()</td></tr>
<tr class="memdesc:a6e2d745cdb7a7b983f861ed6a9a541a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shut down the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a>.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a6e2d745cdb7a7b983f861ed6a9a541a7">More...</a><br /></td></tr>
<tr class="separator:a6e2d745cdb7a7b983f861ed6a9a541a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:acf7e27e5129fb4febbb44dbd372a8a5a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#acf7e27e5129fb4febbb44dbd372a8a5a">IsInitialized</a><code> [get]</code></td></tr>
<tr class="memdesc:acf7e27e5129fb4febbb44dbd372a8a5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports whether the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> has been initialized yet.  <a href="classUnity_1_1MLAgents_1_1Academy.html#acf7e27e5129fb4febbb44dbd372a8a5a">More...</a><br /></td></tr>
<tr class="separator:acf7e27e5129fb4febbb44dbd372a8a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a429eb08c9afdd06c56a4fc8971d1ea66"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html">Academy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a429eb08c9afdd06c56a4fc8971d1ea66">Instance</a><code> [get]</code></td></tr>
<tr class="memdesc:a429eb08c9afdd06c56a4fc8971d1ea66"><td class="mdescLeft">&#160;</td><td class="mdescRight">The singleton <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> object.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a429eb08c9afdd06c56a4fc8971d1ea66">More...</a><br /></td></tr>
<tr class="separator:a429eb08c9afdd06c56a4fc8971d1ea66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08d3822f19e5ca144f5f2bbed1af0571"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a08d3822f19e5ca144f5f2bbed1af0571">IsCommunicatorOn</a><code> [get]</code></td></tr>
<tr class="memdesc:a08d3822f19e5ca144f5f2bbed1af0571"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports whether or not the communicator is on.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a08d3822f19e5ca144f5f2bbed1af0571">More...</a><br /></td></tr>
<tr class="separator:a08d3822f19e5ca144f5f2bbed1af0571"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa777767cc277631a8491ee482f995529"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#aa777767cc277631a8491ee482f995529">InferenceSeed</a><code> [set]</code></td></tr>
<tr class="memdesc:aa777767cc277631a8491ee482f995529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the random seed used for inference.  <a href="classUnity_1_1MLAgents_1_1Academy.html#aa777767cc277631a8491ee482f995529">More...</a><br /></td></tr>
<tr class="separator:aa777767cc277631a8491ee482f995529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a382b4cde08f4dca17870cacc533b97ea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a382b4cde08f4dca17870cacc533b97ea">AutomaticSteppingEnabled</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a382b4cde08f4dca17870cacc533b97ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether or not the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> is automatically stepped during the FixedUpdate phase.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a382b4cde08f4dca17870cacc533b97ea">More...</a><br /></td></tr>
<tr class="separator:a382b4cde08f4dca17870cacc533b97ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a381355b3048a3ec123db3b81106a7bbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html">EnvironmentParameters</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a381355b3048a3ec123db3b81106a7bbb">EnvironmentParameters</a><code> [get]</code></td></tr>
<tr class="memdesc:a381355b3048a3ec123db3b81106a7bbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html" title="A container for the Environment Parameters that may be modified during training.">EnvironmentParameters</a> instance.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a381355b3048a3ec123db3b81106a7bbb">More...</a><br /></td></tr>
<tr class="separator:a381355b3048a3ec123db3b81106a7bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d6b15252750cebce4fad575f23fcd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnity_1_1MLAgents_1_1StatsRecorder.html">StatsRecorder</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a53d6b15252750cebce4fad575f23fcd3">StatsRecorder</a><code> [get]</code></td></tr>
<tr class="memdesc:a53d6b15252750cebce4fad575f23fcd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="classUnity_1_1MLAgents_1_1StatsRecorder.html" title="Add stats (key-value pairs) for reporting.">StatsRecorder</a> instance.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a53d6b15252750cebce4fad575f23fcd3">More...</a><br /></td></tr>
<tr class="separator:a53d6b15252750cebce4fad575f23fcd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f8efed4f10b77a5e88a6f4ad31e477f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a7f8efed4f10b77a5e88a6f4ad31e477f">EpisodeCount</a><code> [get]</code></td></tr>
<tr class="memdesc:a7f8efed4f10b77a5e88a6f4ad31e477f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current episode count.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a7f8efed4f10b77a5e88a6f4ad31e477f">More...</a><br /></td></tr>
<tr class="separator:a7f8efed4f10b77a5e88a6f4ad31e477f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e8dc6caaae14be76726dc80325b9e53"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a8e8dc6caaae14be76726dc80325b9e53">StepCount</a><code> [get]</code></td></tr>
<tr class="memdesc:a8e8dc6caaae14be76726dc80325b9e53"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current step count (within the current episode).  <a href="classUnity_1_1MLAgents_1_1Academy.html#a8e8dc6caaae14be76726dc80325b9e53">More...</a><br /></td></tr>
<tr class="separator:a8e8dc6caaae14be76726dc80325b9e53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb62d081138513449b6cd0f4ada3fd17"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#adb62d081138513449b6cd0f4ada3fd17">TotalStepCount</a><code> [get]</code></td></tr>
<tr class="memdesc:adb62d081138513449b6cd0f4ada3fd17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total step count.  <a href="classUnity_1_1MLAgents_1_1Academy.html#adb62d081138513449b6cd0f4ada3fd17">More...</a><br /></td></tr>
<tr class="separator:adb62d081138513449b6cd0f4ada3fd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="events"></a>
Events</h2></td></tr>
<tr class="memitem:aec1845ba20c598bd773d16361f5751bb"><td class="memItemLeft" align="right" valign="top">Action&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#aec1845ba20c598bd773d16361f5751bb">AgentPreStep</a></td></tr>
<tr class="memdesc:aec1845ba20c598bd773d16361f5751bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals to all of the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>s that their step is about to begin.  <a href="classUnity_1_1MLAgents_1_1Academy.html#aec1845ba20c598bd773d16361f5751bb">More...</a><br /></td></tr>
<tr class="separator:aec1845ba20c598bd773d16361f5751bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f6d5bc7d4e5c0e1a78e22e1ba640406"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a2f6d5bc7d4e5c0e1a78e22e1ba640406">OnEnvironmentReset</a></td></tr>
<tr class="memdesc:a2f6d5bc7d4e5c0e1a78e22e1ba640406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals that the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> has been reset by the training process.  <a href="classUnity_1_1MLAgents_1_1Academy.html#a2f6d5bc7d4e5c0e1a78e22e1ba640406">More...</a><br /></td></tr>
<tr class="separator:a2f6d5bc7d4e5c0e1a78e22e1ba640406"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> singleton manages agent training and decision making. </p>
<p>Access the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> singleton through the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html#a429eb08c9afdd06c56a4fc8971d1ea66" title="The singleton Academy object.">Instance</a> property. The <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> instance is initialized the first time it is accessed (which will typically be by the first <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> initialized in a scene).</p>
<p>At initialization, the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> attempts to connect to the Python training process through the external communicator. If successful, the training process can train <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> instances. When you set an agent's BehaviorParameters.BehaviorType setting to BehaviorType.Default, the agent exchanges data with the training process to make decisions. If no training process is available, agents with the default behavior fall back to inference or heuristic decisions. (You can also set agents to always use inference or heuristics.) </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e2d745cdb7a7b983f861ed6a9a541a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e2d745cdb7a7b983f861ed6a9a541a7">&#9670;&nbsp;</a></span>Dispose()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Dispose </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Shut down the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a>. </p>

</div>
</div>
<a id="a3e751afdd9bf94606b74c3ec143bef6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e751afdd9bf94606b74c3ec143bef6e">&#9670;&nbsp;</a></span>EnvironmentStep()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EnvironmentStep </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Performs a single environment update of the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> and <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> objects within the environment. </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a382b4cde08f4dca17870cacc533b97ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a382b4cde08f4dca17870cacc533b97ea">&#9670;&nbsp;</a></span>AutomaticSteppingEnabled</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool AutomaticSteppingEnabled</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines whether or not the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> is automatically stepped during the FixedUpdate phase. </p>
<p>Set <code>true</code> to enable automatic stepping; <code>false</code> to disable.</p>

</div>
</div>
<a id="a381355b3048a3ec123db3b81106a7bbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a381355b3048a3ec123db3b81106a7bbb">&#9670;&nbsp;</a></span>EnvironmentParameters</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html">EnvironmentParameters</a> <a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html">EnvironmentParameters</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the <a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html" title="A container for the Environment Parameters that may be modified during training.">EnvironmentParameters</a> instance. </p>
<p>If training features such as Curriculum Learning or Environment Parameter Randomization are used, then the values of the parameters generated from the training process can be retrieved here.</p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a id="a7f8efed4f10b77a5e88a6f4ad31e477f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f8efed4f10b77a5e88a6f4ad31e477f">&#9670;&nbsp;</a></span>EpisodeCount</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int EpisodeCount</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The current episode count. </p>
<p>Current episode number. </p>

</div>
</div>
<a id="aa777767cc277631a8491ee482f995529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa777767cc277631a8491ee482f995529">&#9670;&nbsp;</a></span>InferenceSeed</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int InferenceSeed</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the random seed used for inference. </p>
<p>This should be set before any Agents are added to the scene. The seed is passed to the ModelRunner constructor, and incremented each time a new ModelRunner is created.</p>

</div>
</div>
<a id="a429eb08c9afdd06c56a4fc8971d1ea66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a429eb08c9afdd06c56a4fc8971d1ea66">&#9670;&nbsp;</a></span>Instance</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html">Academy</a> Instance</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The singleton <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> object. </p>
<p>Getting the instance initializes the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a>, if necessary.</p>

</div>
</div>
<a id="a08d3822f19e5ca144f5f2bbed1af0571"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08d3822f19e5ca144f5f2bbed1af0571">&#9670;&nbsp;</a></span>IsCommunicatorOn</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool IsCommunicatorOn</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reports whether or not the communicator is on. </p>
<dl class="section see"><dt>See also</dt><dd>ICommunicator</dd></dl>
<p><code>True</code>, if communicator is on, <code>false</code> otherwise. </p>

</div>
</div>
<a id="acf7e27e5129fb4febbb44dbd372a8a5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf7e27e5129fb4febbb44dbd372a8a5a">&#9670;&nbsp;</a></span>IsInitialized</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool IsInitialized</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reports whether the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> has been initialized yet. </p>
<p><code>True</code> if the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> is initialized, <code>false</code> otherwise.</p>

</div>
</div>
<a id="a53d6b15252750cebce4fad575f23fcd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53d6b15252750cebce4fad575f23fcd3">&#9670;&nbsp;</a></span>StatsRecorder</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1StatsRecorder.html">StatsRecorder</a> <a class="el" href="classUnity_1_1MLAgents_1_1StatsRecorder.html">StatsRecorder</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the <a class="el" href="classUnity_1_1MLAgents_1_1StatsRecorder.html" title="Add stats (key-value pairs) for reporting.">StatsRecorder</a> instance. </p>
<p>This instance can be used to record any statistics from the <a class="el" href="namespaceUnity.html">Unity</a> environment.</p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a id="a8e8dc6caaae14be76726dc80325b9e53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e8dc6caaae14be76726dc80325b9e53">&#9670;&nbsp;</a></span>StepCount</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int StepCount</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The current step count (within the current episode). </p>
<p>Current step count. </p>

</div>
</div>
<a id="adb62d081138513449b6cd0f4ada3fd17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb62d081138513449b6cd0f4ada3fd17">&#9670;&nbsp;</a></span>TotalStepCount</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int TotalStepCount</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the total step count. </p>
<p>Total step count. </p>

</div>
</div>
<h2 class="groupheader">Event Documentation</h2>
<a id="aec1845ba20c598bd773d16361f5751bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec1845ba20c598bd773d16361f5751bb">&#9670;&nbsp;</a></span>AgentPreStep</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Action&lt;int&gt; AgentPreStep</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Signals to all of the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a>s that their step is about to begin. </p>
<p>This is a good time for an <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> to decide if it would like to call <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html#ae9f3c050a74cf26e2cd74e82deaa9a5d" title="Requests a new decision for this agent.">Agent.RequestDecision</a> or <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html#a737d24da9fbe954cd4e41983ddee208a" title="Requests an action for this agent.">Agent.RequestAction</a> for this step. Any other pre-step setup could be done during this even as well.</p>

</div>
</div>
<a id="a2f6d5bc7d4e5c0e1a78e22e1ba640406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f6d5bc7d4e5c0e1a78e22e1ba640406">&#9670;&nbsp;</a></span>OnEnvironmentReset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Action OnEnvironmentReset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Signals that the <a class="el" href="classUnity_1_1MLAgents_1_1Academy.html" title="The Academy singleton manages agent training and decision making.">Academy</a> has been reset by the training process. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Academy_8cs.html">Academy.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1Academy.html">Academy</a></li>
  </ul>
</div>
</body>
</html>
